/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering,
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 *
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment.axis;

import java.util.Vector;

import javax.xml.soap.SOAPMessage;

import org.apache.axis.AxisFault;
import org.apache.axis.Handler;
import org.apache.axis.Message;
import org.apache.axis.MessageContext;
import org.apache.axis.handlers.BasicHandler;

import cgl.narada.wsinfra.WsMessageFlow;
import cgl.narada.wsinfra.deployment.SOAPContext;
import cgl.narada.wsinfra.deployment.impl.SoapMessageRouting;
import cgl.narada.wsinfra.exception.MessageFlowException;

/**
 * WsInfraAxisHandler is base class for every handler in wsinfra. The processed
 * Source and Sink messages are received from enrouteToNetwork method and passed
 * into the sender thread. Although it extends BasicHandler class, invoke method
 * is overwritten by extend classes.
 *
 * @author Beytullah Yildiz, Damodar Yemme
 * $Date: 2005/04/19 21:57:56 $
 * $Revision: 1.2 $
 */


public class WsInfraAxisHandler
    extends BasicHandler
    implements WsMessageFlow {

  private String moduleName = "WsInfraAxisHandler : ";
  private String identifier;
  private AxisMessageInjector axisMessageInjector;
  private Vector handlerVector;
  private String soapActionURI;

  public WsInfraAxisHandler() {
  }
  /**
   * Initilize required class instances
   */
  public void initilizeInfraAxisHandler() {

    axisMessageInjector = new AxisMessageInjector();
    axisMessageInjector.start();

    handlerVector = new Vector();
  }

  public void addHandler(Handler handler) {
    System.out.println(moduleName+"Adding a handler");
    handlerVector.add(handler);

  }

  public SOAPContext getSOAPContext(SOAPMessage soapMessage) {
    return null;

  }

  public void setSoapActionURI(String soapActionURI) {
    this.soapActionURI = soapActionURI;
  }

  public String getSoapActionURI() {
    return soapActionURI;
  }

  /** Routes a message enroute to the application. The message is basically
      routed to a neighboring filter which is nearer to the application. */
  public void enrouteToApplication(SOAPMessage soapMessage) throws
      MessageFlowException {

  }
  /**
   * Push up processed messages and send them into Sender Thread
   */
  public final void enrouteToNetwork(SOAPMessage soapMessage) throws
      MessageFlowException {
    SoapMessageRouting soapMessageRouting = SoapMessageRouting.getInstance();
    String destination = null;
    try {
      destination = soapMessageRouting.computeDestination(soapMessage);
    }
    catch (Exception e) {
      System.out.println(moduleName + e);
    }

    //calls handlers
    int handlerSize = handlerVector.size();
    System.out.println(moduleName+ " Handler size: "+handlerSize);
    if (handlerSize > 0) {

      MessageContext messageContext = axisMessageInjector.getServiceCall(
          destination, soapActionURI).getMessageContext();
      messageContext.setResponseMessage((Message)soapMessage);

      for (int i = 0; i < handlerSize; i++) {
        BasicHandler basicHandler = (BasicHandler) handlerVector.get(i);
        try {
          System.out.println("I am inside the handler invoke()");
          basicHandler.invoke(messageContext);
        }
        catch (Exception e) {
          System.out.println(moduleName+e);
        }
      }
    }

    axisMessageInjector.setSoapActionURI(soapActionURI);
    axisMessageInjector.addObjectToList(soapMessage);

  }

  public final void setIdentifier(String identifier) {
    this.identifier = identifier;
  }
  /**
   * This method is overwritten by extend classes
   */
  public void invoke(MessageContext msgContext) throws AxisFault {

    System.out.println("This method is not supposed to be called. ");
    System.out.println("It is overwrited by wsrm handlers ");
  }

}
